Sphinx Extensions API

重要なオブジェクト

ビルド・フェーズ

拡張機能のメタデータ

setup()関数は、ディクショナリを返すよう定義します。

version

指定がない場合には、"unknown version"が代わりに指定されます。

env_version

parallel_read_safe

拡張をロードする際に、ソースファイルの並列読み込みをサポートするかどうかを示す真偽値

デフォルトはFalse

Noteより、以下を満たさなければならない

The core logic of the extension is parallelly executable during the reading phase.

It has event handlers for env-merge-info and env-purge-doc events if it stores data to the build environment object (env) during the reading phase.

parallel_write_safe

デフォルトはTrue